feat: export tagged course as csv by rpenido · Pull Request #34091 · openedx/openedx-platform

rpenido · 2024-01-22T21:50:14Z

Description

This PR implements a feature to export a CSV with the course structure and its blocks, showing all tags applied to them.

More information

Part of:

[Tagging] Download Course Tag Spreadsheet modular-learning#172

Depends on:

feat: Export ID on Taxonomy #34143

Testing instructions

Check the tests cover the implemented feature
Follow the instructions from feat: add export course tags menu frontend-app-authoring#830 to test it from the MFE

Private-ref: FAL-3610

openedx-webhooks · 2024-01-22T21:50:19Z

Thanks for the pull request, @rpenido! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

openedx/core/djangoapps/content_tagging/api.py

openedx/core/djangoapps/content_tagging/rest_api/v1/views.py

openedx/core/djangoapps/content_tagging/api.py

openedx/core/djangoapps/content_tagging/rest_api/v1/serializers.py

openedx/core/djangoapps/content_tagging/rest_api/v1/views.py

…dsheet

openedx/core/djangoapps/content_tagging/rest_api/v1/views.py

openedx/core/djangoapps/content_tagging/rest_api/v1/serializers.py

openedx/core/djangoapps/content_tagging/api.py

openedx/core/djangoapps/content_tagging/tests/test_api.py

openedx/core/djangoapps/content_tagging/api.py

openedx/core/djangoapps/content_tagging/rest_api/v1/views.py

…into rpenido/fal-3610-download-course-tag-spreadsheet

…dsheet

pomegranited

👍

I tested this on my devstack
- Use https://github.com/open-craft/taxonomy-sample-data/ to create some tagged content.
- Using the "Export tags" menu added by openedx/frontend-app-authoring#830, exported tags for http://localhost:2001/course/course-v1:SampleTaxonomyOrg2+STC1+2023_1
- Checked that course tags appear where expected.
- Tested that exporting tags for an untagged courses works as expected (no taxonomies, no tags in the CSV): http://localhost:2001/course/course-v1:edX+DemoX+Demo_Course/export/
- Imported the CSV files into Google Sheets to verify that the course tree nesting is preserved as expected.
I read through the code
I checked for accessibility issues by using my keyboard to navigate.
Includes documentation (docstrings)
~~User-facing strings are extracted for translation~~ N/A

bradenmacdonald

Looks good! Please just make this one change and then I can merge.

openedx/core/djangoapps/content_tagging/rest_api/v1/urls.py

openedx/core/djangoapps/content_tagging/rest_api/v1/views.py

Co-authored-by: Braden MacDonald <mail@bradenm.com>

…dsheet

rpenido · 2024-02-15T15:19:23Z

Looks good! Please just make this one change and then I can merge.

Done: 01b9b5f

I think we have a test failing upstream (not related to this code): #34243

…dsheet

rpenido · 2024-02-16T13:38:34Z

@bradenmacdonald This is ready for a final review and merge!

openedx-webhooks · 2024-02-16T17:56:33Z

@rpenido 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-pipeline-bot · 2024-02-16T19:08:53Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2024-02-16T19:28:33Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2024-02-16T19:28:33Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2024-02-16T19:47:33Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2024-02-16T20:05:34Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2024-02-16T20:05:34Z

2U Release Notice: This PR has been deployed to the edX production environment.

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 22, 2024

feat: export tagged course as csv

52bc665

rpenido force-pushed the rpenido/fal-3610-download-course-tag-spreadsheet branch from 23ade2b to 52bc665 Compare January 25, 2024 19:41

rpenido changed the title ~~feat: get course blocks with tags WIP~~ feat: export tagged course as csv WIP Jan 25, 2024

rpenido commented Jan 25, 2024

View reviewed changes

openedx/core/djangoapps/content_tagging/api.py Outdated Show resolved Hide resolved

rpenido commented Jan 25, 2024

View reviewed changes

openedx/core/djangoapps/content_tagging/rest_api/v1/views.py Outdated Show resolved Hide resolved

docs: add comment

f275908

pomegranited requested changes Jan 26, 2024

View reviewed changes

rpenido added 8 commits January 26, 2024 10:47

fix: add select_related to ObjectTag query

a870dfd

fix: always use objecttag.value

4dd027a

docs: change comment position

5fb03aa

refactor: rename serializer to a more sane name

8f1238e

refactor: remove download param

bdedf93

refactor: create a new view to export objecttags

04ca072

Merge branch 'master' into rpenido/fal-3610-download-course-tag-sprea…

a8a6e7e

…dsheet

refactor: change api and view structure

b01d6d4

rpenido force-pushed the rpenido/fal-3610-download-course-tag-spreadsheet branch from 9858cd3 to b01d6d4 Compare January 29, 2024 15:21

rpenido added 2 commits January 29, 2024 12:34

Merge branch 'master' into rpenido/fal-3610-download-course-tag-sprea…

0871537

…dsheet

docs: remove old comment

18a8425

pomegranited reviewed Jan 30, 2024

View reviewed changes

openedx/core/djangoapps/content_tagging/rest_api/v1/views.py Outdated Show resolved Hide resolved

rpenido added 8 commits January 30, 2024 14:05

docs: revert view docstring

38ae353

fix: remove include_children query param

b65a6c8

fix: removing .all() call from queryset

f5ac3a6

refactor: method rename

debf254

fix: filter deleted tags

9726d6d

fix: pylint

c8c12bb

fix: quote string in csv export

1f11b17

test: add querycount

484c042

rpenido added 6 commits February 5, 2024 18:49

style: fix case

da3fdf9

Merge branch 'jill/rpenido/fal-3610-download-course-tag-spreadsheet' …

726b7ef

…into rpenido/fal-3610-download-course-tag-spreadsheet

docs: adds removed docstring

fd5a542

Merge branch 'master' into rpenido/fal-3610-download-course-tag-sprea…

79a1786

…dsheet

fix: cleaning merged code

dfe43be

style: run isort

5245264

rpenido mentioned this pull request Feb 9, 2024

feat: add export course tags menu openedx/frontend-app-authoring#830

Merged

refactor: use taxonomy.export_id in header

c82e9cb

rpenido marked this pull request as ready for review February 9, 2024 22:26

rpenido requested a review from pomegranited February 9, 2024 22:26

pomegranited approved these changes Feb 13, 2024

View reviewed changes

bradenmacdonald approved these changes Feb 14, 2024

View reviewed changes

rpenido and others added 3 commits February 15, 2024 10:15

refactor: change object_id to context_id

01b9b5f

Co-authored-by: Braden MacDonald <mail@bradenm.com>

Merge branch 'master' into rpenido/fal-3610-download-course-tag-sprea…

f87fc4c

…dsheet

chore: trigger CI

779cc98

rpenido mentioned this pull request Feb 15, 2024

feat: export tagged content library as csv [FC-0049] #34246

Merged

Merge branch 'master' into rpenido/fal-3610-download-course-tag-sprea…

4a3d092

…dsheet

bradenmacdonald merged commit 4d1d82d into openedx:master Feb 16, 2024

rpenido deleted the rpenido/fal-3610-download-course-tag-spreadsheet branch February 20, 2024 13:09

bradenmacdonald mentioned this pull request Mar 11, 2024

[Tagging] Handle tags when importing/exporting courses openedx/modular-learning#182

Closed

Conversation

rpenido commented Jan 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

More information

Testing instructions

Uh oh!

openedx-webhooks commented Jan 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pomegranited left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rpenido commented Feb 15, 2024

Uh oh!

rpenido commented Feb 16, 2024

Uh oh!

openedx-webhooks commented Feb 16, 2024

Uh oh!

edx-pipeline-bot commented Feb 16, 2024

Uh oh!

edx-pipeline-bot commented Feb 16, 2024

Uh oh!

edx-pipeline-bot commented Feb 16, 2024

Uh oh!

edx-pipeline-bot commented Feb 16, 2024

Uh oh!

edx-pipeline-bot commented Feb 16, 2024

Uh oh!

edx-pipeline-bot commented Feb 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

rpenido commented Jan 22, 2024 •

edited

Loading

openedx-webhooks commented Jan 22, 2024 •

edited

Loading